CP/M/CPM_CDROM.iso/commodor/kermit2.sda/KERMIT 4.DOC

Text File | 1993-05-20 | 11KB | 397 lines

├-64/128 ╦ERMIT ╒SER'S ╟UIDE                         ╨AGE 17


╞ILE ╘RANSFERS: ╘RANSFERRING ╞ILES

╘RANSFERRING FILES WITH ╦ERMIT ISN'T REALLY ANY MORE DIFFI-
CULT THAN WITH MOST OTHER ├OMMODORE TELECOMMUNICATIONS
PACKAGES/PROTOCOLS.  ╔N FACT, ╦ERMIT IS MUCH MORE FLEXIBLE--
BUT FLEXIBILITY CAN BE CONFUSING.

╘HERE ARE THREE MAJOR PARAMETERS TO BE CONCERNED WITH WHEN
TRANSFERRING FILES.  ╘HEY ARE: 1) ╞ILE-TYPE, 2) ╞ILE-BYTE-
SIZE, AND 3) ┼IGHT-BIT-QUOTING.  ╠ET'S DISCUSS EACH OF THEM
IN TURN, BEGINNING WITH ╞ILE-TYPE.


  ├HOOSING THE ├ORRECT ╞ILE-TYPE

╦ERMIT CURRENTLY SUPPORTS FIVE DIFFERENT FILE TYPES. ╘HEY
ARE:

    A) ┴╙├╔╔
    B) ┬INARY
    C) ├-╨OWER
    D) ╨┼╘╙├╔╔
    E) ╙CRIPT

┼ACH OF THESE FILE TYPES HAS A DISTINCT USE.  ╫HEN TO USE
ONE FILE-TYPE OVER ANOTHER CAN BE CONFUSING INITIALLY.  ╙O,
WE'LL DISCUSS EACH OF THEM SEPARATELY, STARTING WITH ┴╙├╔╔.

    ┴╙├╔╔ ╞ILE-TYPE

╘HIS FILE-TYPE IS USED A LOT LESS OFTEN THAN YOU MIGHT THINK
AT FIRST.  ┬ECAUSE ├OMMODORE COMPUTERS (EXCEPT FOR THE ┴MI-
GAS AND ╨├S) USE THEIR OWN, MODIFIED CHARACTER SET ARRANGE-
MENT (╨┼╘╙├╔╔), MOST TEXT FILES YOU TRANSFER TO AND FROM
YOUR ├OMMODORE WILL BE ╨┼╘╙├╔╔ FILES, NOT STANDARD ┴╙├╔╔.

┘OU WILL USE THIS FILE-TYPE ONLY WHEN YOU A) WISH TO DOWN-
LOAD A STANDARD ┴╙├╔╔ FILE AND ╬╧╘ CONVERT IT TO A FORM
USABLE ON YOUR ├OMMODORE (╨┼╘╙├╔╔), OR B) YOU HAVE, FOR SOME
REASON, A STANDARD ┴╙├╔╔ FILE THAT YOU WISH TO UPLOAD TO
ANOTHER COMPUTER.

╔F YOU HAPPEN TO CHOOSE THIS FILE-TYPE WHEN YOU REALLY
NEEDED ╨┼╘╙├╔╔, YOU WILL BE ABLE TO TELL IMMEDIATELY, AS THE
CASE OF ALL THE TEXT WILL BE REVERSED.

    ┬INARY ╞ILE-TYPE

╘HE ┬INARY FILE-TYPE IS NOT USED AS OFTEN AS SOME OF THE
OTHER FILE-TYPES.  ╘HIS FILE-TYPE IS USED TO TRANSFER ├OMMO-
DORE PROGRAMS THAT ARE EXECUTABLE (I.E. A ┬┴╙╔├ PROGRAM OR A
MACHINE LANGUAGE GAME), OR MEMORY IMAGES SUCH AS GRAPHICS
SCREENS.  ╔N OTHER, MORE TECHNICAL, TERMS, THIS FILE-TYPE










╨AGE 18                         ├-64/128 ╦ERMIT ╒SER'S ╟UIDE


ALLOWS YOU TO TRANSFER FILES WITHOUT PERFORMING ANY CHARAC-
TER TRANSLATION.  ╬OTE THAT IT'S GENERALLY A GOOD IDEA TO
HAVE ┼IGHT-BIT-QUOTING SET ON WHEN TRANSFERRING BINARY
FILES, BUT MORE ABOUT THAT BELOW.

    ├-╨OWER ╞ILE-TYPE

╘HIS FILE-TYPE IS DESIGNED SPECIFICALLY TO TRANSFER SOURCE
CODE FILES FOR USE WITH THE ├ ╨OWER (NOW SOLD AS ╨OWER ├) ├
COMPILER FOR THE ├-64 AND ├-128.  ├ ╨OWER FILES HAVE, IN
ADDITION TO THE STANDARD ╨┼╘╙├╔╔ FILE-TYPE BASE, A FEW RE-
DEFINED CHARACTERS THAT ARE NEEDED FOR ├ PROGRAMMING, SUCH
AS BRACES, THE UNDERSCORE, THE PIPE, ETC.

╫HEN YOU USE THIS FILE-TYPE, ANY STANDARD ├ SOURCE CODE
FILES YOU DOWNLOAD TO YOUR ├OMMODORE WILL BE CONVERTED TO ├
╨OWER FORMAT.  ╧N THE OTHER SIDE OF THE COIN, ANY ├ ╨OWER
FILES YOU UPLOAD TO ANOTHER COMPUTER WILL BE CONVERTED TO
STANDARD ┴╙├╔╔ SOURCE CODE FILES.

    ╨┼╘╙├╔╔ ╞ILE-TYPE

╘HIS FILE-TYPE IS THE MOST COMMON FILE-TYPE, AND SO IT IS
THE DEFAULT ╦ERMIT FILE-TYPE.  ╫HEN YOU USE THIS FILE-TYPE,
ANY ├OMMODORE TEXT FILE YOU UPLOAD TO ANOTHER COMPUTER WILL
BE CONVERTED TO STANDARD ┴╙├╔╔ TEXT.  ╟OING THE OTHER DIREC-
TION, WHEN YOU DOWNLOAD A STANDARD ┴╙├╔╔ TEXT FILE TO YOUR
├OMMODORE, IT WILL BE TRANSLATED TO ╨┼╘╙├╔╔.

╔F YOU CHOOSE THIS FILE TYPE WHEN YOU REALLY MEANT ┴╙├╔╔,
THE CASE OF ALL THE LETTERS IN THE TEXT WILL BE REVERSED.

    ╙CRIPT ╞ILE-TYPE

╘HIS IS A SPECIAL FILE-TYPE FOR USE WHEN TRANSFERRING FILES
FOR THE ├OMMODORE ╙PEEDSCRIPT WORD PROCESSOR (├OMPUTE! ╨UB-
LICATIONS).  ╙PEEDSCRIPT FILES HAVE A SPECIAL FILE FORMAT.
╔F YOU WANT TO DOWNLOAD A STANDARD TEXT FILE FROM ANOTHER
COMPUTER FOR ╙PEEDSCRIPT, YOU MUST USE THIS FORMAT.  ╘HE
SAME APPLIES FOR SENDING A ╙PEEDSCRIPT FILE TO ANOTHER COM-
PUTER THAT USES STANDARD ┴╙├╔╔ TEXT FILES.  ╬OTE THAT NO
ATTEMPT IS MADE TO TRANSLATE ANY OF ╙PEEDSCRIPT'S SPECIAL
TEXT FORMATTING OR CONTROL CODES-- YOU WILL HAVE TO MAKE THE
APPROPRIATE CHANGES MANUALLY.


  ╙ETTING THE ╞ILE-BYTE-SIZE

╘HIS PARAMETER IS OFTEN CONFUSING BECAUSE IT SOUNDS A LOT
LIKE THE ╫ORD-SIZE PARAMETER.  ╘HESE TWO PARAMETERS ARE
ACTUALLY QUITE DIFFERENT.  ╫HEREAS ╫ORD-SIZE DESCRIBES THE
WIDTH OF THE DATA PATH, ╞ILE-BYTE-SIZE DESCRIBES THE SIZE OF
THE DATA WORDS WITHIN FILES BEING TRANSFERRED.










├-64/128 ╦ERMIT ╒SER'S ╟UIDE                         ╨AGE 19


╘HIS PARAMETER CAN ALWAYS BE LEFT SET TO ┼╔╟╚╘-┬╔╘.  ╘ECHNI-
CALLY, IT IS REALLY ONLY NECESSARY TO BE SET TO ┼╔╟╚╘-┬╔╘
WHEN YOU ARE TRANSFERRING ┬INARY OR ╨┼╘╙├╔╔ FILES.


  ╒SING ┼IGHT-BIT-QUOTING

╘HIS FEATURE ALLOWS YOU TO TRANSFER ┬INARY OR ╨┼╘╙├╔╔ FILES
TO AND FROM COMPUTERS THAT WOULD NORMALLY BE UNABLE TO HAN-
DLE THEM.  ┼IGHT-BIT-QUOTING ALLOWS YOU TO SEND FILES WITH
EIGHT-BIT DATA WORDS OVER A SEVEN-BIT DATA PATH.  ╘HIS
PARAMETER CAN ALWAYS BE LEFT SET TO ╧╬.

╞OR INSTANCE, ╔ OFTEN COMMUNICATE WITH A MACHINE WHERE MY
COMMUNICATIONS PARAMETERS HAVE TO BE ╫ORD-SIZE OF ╙EVEN-BIT
AND ┼VEN ╨ARITY.  ╔N THIS KIND OF ENVIRONMENT ╔ WOULD NOR-
MALLY BE UNABLE TO SEND A PROGRAM FILE TO A FRIEND ON THAT
MACHINE, AS PROGRAM FILES ARE ┬INARY (EIGHT-BITS).  ┬UT IF ╔
MAKE SURE ┼IGHT-BIT-QUOTING IS ╧╬, EVERYTHING WILL BE FINE.

╘ECHNICALLY, ┼IGHT-BIT-QUOTING PREFIXES EACH BYTE OF DATA
THAT IS OVER SEVEN BITS LONG (GREATER THAN ┴╙├╔╔ 127 DECIMAL
IN VALUE) SO THAT IT CAN BE TRANSFERRED ALONG A SEVEN-BIT
DATA PATH.


  ╙PECIAL ╞ILE-╘RANSFER ═ODE ╞EATURES

╘HERE ARE THREE HELPFUL FEATURES AVAILABLE WHEN TRANSFERRING
FILES.  ╘HESE FEATURES ARE STANDARD IN MOST VERSIONS OF ╦ER-
MIT.  ╘HEY ARE:

    ╦EY ╙EQUENCE   ┴CTION

    <╥┼╘╒╥╬>       ╞ORCE LOCAL ╦ERMIT TO RE-SEND CURRENT PACKET
    <├╘╥╠> - <╪>   ├ANCEL TRANSMISSION OF CURRENT FILE
    <├╘╥╠> - <┘>   ├ANCEL TRANSMISSION OF ENTIRE BATCH OF FILES

┴LL OF THESE COMMANDS ARE AVAILABLE WHEN RECEIVING A FILE OR
FILES.  ┬ECAUSE ├-64/128 ╦ERMIT CAN'T SEND MORE THAN ONE
FILE PER ╙┼╬─ COMMAND (A FEATURE CALLED "WILDCARD SEND"),
THE <├╘╥╠> - <┘> FEATURE IS NOT APPLICABLE WHEN SENDING A
FILE.




















╨AGE 20                         ├-64/128 ╦ERMIT ╒SER'S ╟UIDE


╥EFERENCE: ├OMMAND ─ESCRIPTIONS



  ├OMMAND ╠IST


╦ERMIT V2.2 HAS 16 MAJOR COMMANDS, MANY OF WHICH HAVE SUB-
OPTIONS.  ┬ELOW IS A LIST OF THE MAJOR COMMANDS.

    ┬YE    ├ONNECT   ─IRECTORY   ─ISK      ┼XIT      ╞INISH
    ╟ET    ╚ELP      ╤UIT        ╥ECEIVE   ╥ESTORE   ╙AVE
    ╙END   ╙ET       ╙HOW        ╙TATUS


  ├OMMAND ╙UMMARY

┼ACH OF THE MAJOR COMMANDS ARE DESCRIBED BELOW IN ALPHABETI-
CAL ORDER.  ╞OLLOWING THE DESCRIPTION IS ONE OR MORE EXAM-
PLES USING THE COMMAND PREVIOUSLY DESCRIBED.  ╨LEASE NOTE
THAT ALL COMMANDS MAY BE ENTERED IN EITHER LOWER OR UPPER
CASE-- CASE DISTINCTION IS NOT MADE BY THE ╦ERMIT PARSER.

    ┬YE

╘HIS COMMAND CAUSES ├-64/128 ╦ERMIT TO TELL THE REMOTE ╦ER-
MIT, WHICH MUST BE IN SERVER MODE, TO EXIT AND, IF APPLICA-
BLE, TERMINATE ITS JOB (OR PROCESS, ETC.).  ╘HE REMOTE ╦ER-
MIT THEN CLOSES THE CONNECTION.  ├-64/128 ╦ERMIT FINISHES BY
EXITING TO ┬┴╙╔├.  ┬YE HAS NO ARGUMENTS, WITH THE FORMAT:

╦ERMIT-65>BYE

    ├ONNECT

╘HE ├╧╬╬┼├╘ COMMAND PUTS ╦ERMIT INTO ├ONNECT ═ODE (SEE THE
╔NTRODUCTION TO ╦ERMIT SECTION FOR MORE INFORMATION ON ├ON-
NECT ═ODE).  ╦ERMIT CAN THEN BEGIN COMMUNICATION WITH
ANOTHER COMPUTER AS A TERMINAL (AS DEFINED BY THE ╙┼╘
╘┼╥═╔╬┴╠-┼═╒╠┴╘╔╧╬ COMMAND).  ├ONNECT HAS NO ARGUMENTS, WITH
THE FORMAT:

╦ERMIT-65>CONNECT

╘O RETURN TO ├OMMAND ═ODE (SEE THE ╔NTRODUCTION TO ╦ERMIT
SECTION FOR MORE INFORMATION ON ├OMMAND ═ODE), TYPE THE
ESCAPE CHARACTER FOLLOWED BY A <"C">.  ╘HE DEFAULT ESCAPE
CHARACTER IS <├╘╥╠> - <┘>.  ╘HE ESCAPE CHARACTER MAY BE FOL-
LOWED BY CHARACTERS OTHER THAN <"C">.  ╘HE OTHER VALID
OPTIONS AND WHAT THEY DO CAN BE VIEWED BY SUBSTITUTING A
<"?"> FOR THE <"C">, GIVING THE FOLLOWING DISPLAY:












├-64/128 ╦ERMIT ╒SER'S ╟UIDE                         ╨AGE 21


    ╧NE OF THE FOLLOWING:
    ?             - THIS HELP MESSAGE.
    B             - SEND A BREAK SIGNAL.
    C             - CLOSE THE CONNECTION.
    S             - STATUS OF CONNECTION.
    0             - SEND A NULL.
    ESCAPE-CHAR   - TRANSMIT THE ESCAPE CHARACTER.

    ─IRECTORY

╘HE ─╔╥┼├╘╧╥┘ COMMAND RETURNS A DISK DIRECTORY OF THE SPECI-
FIED FILES ON DEVICE 8 (THE NORMAL DEVICE NUMBER FOR THE
FIRST SERIAL ├OMMODORE DISK DRIVE).  ─╔╥┼├╘╧╥┘ WITH NO ARGU-
MENTS RETURNS A COMPLETE DISK DIRECTORY.  ╘HE DIRECTORY MAY
BE PAUSED BY PRESSING <╙╨┴├┼> AND RESUMED BY PRESSING ANY
KEY, AND ABORTED BY PRESSING <╙╘╧╨>.  ╘HE FORMAT IS:

╦ERMIT-65>DIRECTORY [FILENAME]

WHERE [FILENAME] IS A VALID ├┬═ ─╧╙ FILENAME.  ╙OME EXAM-
PLES:

    ╦ERMIT-65>DIRECTORY        (DIRECTORY OF ALL FILES
                               ON DEVICE 8)

    ╦ERMIT-65>DIRECTORY KER*   (DIRECTORY OF FILES BE-
                               GINNING WITH "KER")

    ╦ERMIT-65>DIRECTORY K?W    (DIRECTORY OF FILES 3
                               CHARACTERS LONG, BEGIN-
                               NING WITH "K" AND ENDING
                               WITH "W")

    ─ISK

╘HE ─╔╙╦ COMMAND ALLOWS YOU TO SEND ─╧╙ COMMANDS DIRECTLY TO
THE DISK DRIVE CONTROLLER.  ╘HIS COMMAND IS USEFUL FOR INI-
TIALIZING THE DRIVE, FORMATTING A DISK, AND DELETING
UNWANTED FILES.  ╘HIS COMMAND SUPPORTS ALL THE STANDARD ├OM-
MODORE ─╧╙ COMMANDS, EXCEPT THAT ╬╧ SPACES IN FILENAMES ARE
ALLOWED.  ╘HIS IS ACTUALLY A "FEATURE" OF THE PARSER AND
WILL BE CORRECTED IN A FUTURE VERSION.  ─╔╙╦ WITH NO ARGU-
MENTS WILL RETURN THE DRIVE ERROR IN STANDARD ─╧╙ FORMAT IF
THE DRIVE'S RED LIGHT IS BLINKING.  ╘HE FORMAT IS:

╦ERMIT-65>DISK [STRING]

WHERE [STRING] IS A VALID ├┬═ ─╧╙ COMMAND.  ╙OME EXAMPLES:















╨AGE 22                         ├-64/128 ╦ERMIT ╒SER'S ╟UIDE


    ╦ERMIT-65>DISK S0:K*         (DELETE ALL FILES BEGIN-
                                 NING WITH "K" ON DEVICE
                                 8)

    ╦ERMIT-65>DISK I0:           (INITIALIZE DEVICE 8)

    ╦ERMIT-65>DISK N0:FILES,01   (FORMAT DISK IN DEVICE 8,
                                 GIVING IT NAME "FILES"
                                 AND ID "01"-- NOTE THE
                                 LACK OF SPACES IN THE
                                 DISK NAME CHOSEN)

    ┼XIT

╘HE ┼╪╔╘ COMMAND CAUSES ├-64/128 ╦ERMIT TO STOP EXECUTION
AND RETURN CONTROL OF THE MACHINE TO ┬┴╙╔├.  ╘HIS COMMAND IS
THE SAME AS THE ╤╒╔╘ COMMAND.  ╦ERMIT MAY BE RESTARTED
IMMEDIATELY WITH THE COMMAND ╥╒╬.  ╔F YOU TYPE ╬┼╫, ╦ERMIT
CAN STILL BE RESTARTED MOST OF THE TIME WITH THE COMMAND ╙┘╙
2064.  ┼XIT HAS NO ARGUMENTS.  ╘HE FORMAT OF THIS COMMAND
IS:

╦ERMIT-65>EXIT

    ╞INISH

╘HIS COMMAND CAUSES ├-64/128 ╦ERMIT TO TELL THE REMOTE ╦ER-
MIT, WHICH MUST BE IN SERVER MODE, TO EXIT.  ╫HEN ├-64/128
╦ERMIT RECEIVES THE ACKNOWLEDGEMENT THAT THIS IS BEING DONE,
YOU ARE PROMPTED FOR ANOTHER COMMAND.  ╞INISH HAS NO ARGU-
MENTS, WITH THE FORMAT:

╦ERMIT-65>FINISH

    ╟ET

╘HIS COMMAND CAUSES ├-64/128 ╦ERMIT TO REQUEST THAT THE
OTHER ╦ERMIT (WHICH MUST BE RUNNING IN SERVER MODE) TO
TRANSMIT THE SPECIFIED FILE TO THE ├-64/128 ╦ERMIT.  ╘HE
FORMAT OF THIS COMMAND IS:

╦ERMIT-65>GET [FILE-SPECIFICATION]

WHERE [FILE-SPECIFICATION] IS A VALID FILE SPECIFICATION FOR
THE SYSTEM ON WHICH THE OTHER ╦ERMIT IS RUNNING.

    ╤UIT

╘HIS COMMAND CAUSES ├-64/128 ╦ERMIT TO STOP EXECUTION AND
RETURN CONTROL OF THE MACHINE TO ┬┴╙╔├.  ╤╒╔╘ IS IDENTICAL
TO THE ┼╪╔╘ COMMAND (SEE ┼╪╔╘ ABOVE FOR MORE INFORMATION).
╤╒╔╘ HAS NO ARGUMENTS.  ╘HE FORMAT THIS COMMAND IS: